﻿==============================================================================
===============                  Mission Loader                ===============
===============                   version 1.15                 ===============
===============                created by podvoxx              ===============
==============================================================================
        Pilot Training platform for "IL-2 Sturmovik: Cliffs of Dover"
==============================================================================
******************************************************************************


==============================================================================
   * Description *
______________________________________________________________________________
   The script designed to load missions from the menu in the game. You may fly in online or offline, and upload any task from the menu. Loading missions in the menu <"Tab" + "4">.   
   Use markers if you can not find the target(not all missions have a description).


==============================================================================
   * Install, setup and run *
______________________________________________________________________________
   Important! If you have a previous version remove the folder old version "MissionLoader" by saving your missions. After new "MissionLoader" installing copy your missions back.

   1. Unpack the archive and copy the directory MissionLoader to the folder "X: \ ... \ Documents \ 1C SoftClub \ il-2 sturmovik cliffs of dover \ missions " on your computer.

   2. Run the file host-channel.mis and check MissionLoader. To do this, click <"Tab" + "4"> and select any mission . You get message about the successful launch of the mission. If there are errors - check the implementation of paragraph 1.


==============================================================================
   * Setup and use *
______________________________________________________________________________
   1. Setting up the names of menu items. 
      If you do not want any folder or file to appear in the mission menu - just place "-" in the beginning of the file name or folder. The mission or folder will be excluded from the menu.
      
   2. Restart MissionLoader.
      Periodically restart the mission to clear the map of the broken equipment and facilities.

   3. How to change the host-mission (the position and number of respawns, available aircrafts and weapons, etc.)
      To change the height and position of the starting points, respawn, and the available aircrafts and weapons, edit the file "host-channel.mis" in the full editor.
       The script is called from the boot script file - "host-channel.cs".
       The file "host-channel.mis" are only for the blue respawns with all available aircraft for each and a single Bf109E-3B aircraft to offline - you can add to the mission respawns, aircrafts or other objects.
       You can add the folder "MissionLoader" its core mission of the file under the condition that creates a copy of the script "host-channel.cs" in your boot with the same name as the name of your mission.

   4. How do I add my mission to build.
      Put your mission or in an existing folder in the assembly, or create your own. The folder name and file name mission will be a menu item in the game.


==============================================================================
   * The structure of files and folders *
______________________________________________________________________________
      In the main folder of the loader (missions \ MissionLoader \ MissionPack) are folders that are placed in the assembly missions - mission packs.
      No restrictions on the number of folders and files. 
      No restrictions on the name of folders and files.
      The folder name is the name of the menu item.
      Mission only read from the mission packs and only there to be.


==============================================================================
   * Setting the missions *
______________________________________________________________________________  			
    
      You can create a text file for configure missions properties. Txt-file in the UTF-8 to set the individual parameters of each mission, with its name must match the file name of the mission. At the beginning of the file in the first eight lines is written the name of the menu item on all languages​​, the choice of which will be called load mission - such as "Kipasso nopasarametr!" instead of "Start Battle.mis" on default settings.


    -------------------------------------------------------------------------
      =Setup file format=
    -------------------------------------------------------------------------
№ 
line

01         4xBf110 attack - 3min      //en Menu item name in english
02         Отправить в атаку 4xBf110  //ru  ..in russian
03         Tommi Kaput                //de  
04         4xBf110 attack - 3min      //fr
05         4xBf110 attack - 3min      //es
06         4xBf110 attack - 3min      //cs
07         4xBf110 attack - 3min      //it
08         4xBf110 attack - 3min      //pl
09         2                          //max number of mission loadings (in default = 1)
    -------------------------------------------------------------------------
      
      line 9 - max number of mission loadings (in default = 1)

      You can also assign ownership of the mission of the parties, which the pilots will be able to load the mission (the other players side it will not be on the menu). To do this at the beginning of the file name, add the prefix of the mission "red_" or "blue_". The mission without a prefix will be available to all.

      =Default parameters=
      ------------------------------------------
   -  name of the menu item - mission filename (example "Ju87 attack - 3min.mis")
   -  mission is available for load to all players, regardless of the side (red or blue)
   -  mission can be downloaded only once


==============================================================================
   * setup.txt *
______________________________________________________________________________
      See setup.txt in folder "MissionLoader/System" for config and setup MissionLoader.


    -------------------------------------------------------------------------
      =setup.txt format=
    -------------------------------------------------------------------------
№ 
line

01         Mission Loader Menu      //MissionLoader menu item name
02         1                        //version of the startup messages of the mission
02         auto                     //Setup localized message
04         1                        //ON/OFF reading menu item name from .txt-file for all missions
05         1                        //ON/OFF blue/red filter 
    --------------------------------------------------------------------------

      line 1 - name of the menu item to enter the MissionLoader. You can change it.

      line 2 - version of the server messages about loading the mission (1 - only the file name of the mission, 2 - full path to the mission).
      line 3 - choice of language output messages. May take the following values​​:
        auto - language output messages is determined automatically depending on the version of the game
          en
          ru
          de
          fr
          es
          cs
          it
          pl

      line 4 - ON/OFF reading menu item name from .txt-file for all missions( 1 - ON, 0 - OFF )

      line 5 - ON/OFF blue/red filter ( 1 - ON, 0 - OFF ). Mission designed for players side "Blue" will be available for players side "Red" and vice versa.


==============================================================================
   * Описание работы загрузчика *
______________________________________________________________________________
      The script file is located here: missions\MissionLoader\System\missionloader.cs
      First mission starts "host-channel.mis", that calls script MissionLoader script.


==============================================================================
   * Credits *
______________________________________________________________________________   
   1. naryv and Small_Bee for the help in the my script-work.
   2. FG28_Kodiak for useful information on forums and excellent scripts.
   3. Ataros(Atas) for mission pack "Fighter Training". 
   4. KDN for mission pack "KDN Pack".

      Thanks!

==============================================================================
   * Links *
______________________________________________________________________________

   1. http://www.sukhoi.ru/forum/showthread.php?t=72909&p=1744303#post1744303
   2. http://forum.1cpublishing.eu/showthread.php?t=28056

==============================================================================
   * Author and Copyright *
______________________________________________________________________________

      Alexey "podvoxx" Schwab
      podvoxx@yahoo.com

      You can use the MLoader in their designs and modify it as you want. The MLoader is totally free to use.



==============================================================================
                             * Version History *
______________________________________________________________________________


vvv----------------------------Version 1.15 - 17.12.11----------------------vvv
 
   1. Introduced localization messages. Now, messages are displayed in the language of the player.
   2. Introduced the localization of the menu items described in the txt-file.
   3. Added ability to display a menu of the mission, depending on the player - "Blue" or "Red." The function is disabled in the settings.
   4. Added ability to disable reading of the names of menu items from the txt-file.
   5. Mission on the menu now marked with "*" before the name of the menu item.
   6. No limit on the number of menu items. Now the folders and files can be any number - the menu is split into pages.
   7. Added readme in English and Russian. In the folder "Readme" boot also has examples of configuration files with commentary and a test set of missionaries packs (not for games, only to see the navigation options on the menu).
   8. Added 60 new missions of KDN. Thanks to him!
   9. Corrected mission "Attack The Village" - now some of the reinforcements can be called multiple times.
^^^------------------------------------------------------------------------^^^


vvv----------------------------Version 1.10 - 04.12.11----------------------vvv

   1. Теперь не обязательно прописывать название пунктов меню - если текстовый файл отсутствует - названием пункта меню будет имя файла.
   2. Убрал из сборки полностью русский язык, так как не успеваю делать две версии, а локализацию еще не встроил.
   3. Добавлен пак тренировочных миссий для истребителя от Атаса "Default 3 - Fighter Training" за что ему низкий поклон и человеческое спасибо .
   4. Переработана структура папок.
   5. Теперь, если поставить в начале имени файла или папки тире - она/он не будет отображаться как пункт меню. Это позволит держать в папке загрузчика неограниченное количество файлов и папок без копирования в другие директории.
   6. Добавлен пак миссий с масштабным сражением за французскую деревушку - "Default 2 - Attack The Village". Впервые игроку дана возможность не только самому воевать, но и вызывать подкрепления и давать приказ наземным войсками на начало атаки. Подробнее см. первый пост темы.
   7. Ридми временно устранен из сборки для приведения в божеский вид, вся информация пока на форуме.

^^^------------------------------------------------------------------------^^^


vvv----------------------------Version 1.05 - 25.11.11----------------------vvv

   1. Добавлено автоматическое определение пути к миссиям скриптом загрузчика, теперь не нужно его прописывать самостоятельно.
   2. Теперь для запуска онлайн и сингл миссий используется один и тот же файл, вместо двух как было в первой версии.
   3. Мелкие изменения в структуре папок.
   4. Путь к миссиям стал короче, загрузчик лежит теперь по адресу X:\...\Documents\1C SoftClub\il-2 sturmovik cliffs of dover\missions\

^^^------------------------------------------------------------------------^^^